Health Cloud Administration System API - Implementation Template
Field mapping
Patient Resource
| FHIR Field Name | Salesforce Object Name | Salesforce Field Name | Notes |
|---|---|---|---|
| active | Account | IsActive | |
| name.family | PersonName | LastName | The name information for a patient is represented as Person​Name records that reference the patient record using their Person​Name​.Parent​RecordId field​. |
| name.given | PersonName | FirstName | |
| name.suffix | PersonName | Suffix | |
| name.prefix | PersonName | Prefix | |
| name.use | PersonName | NameUsageType | |
| gender | Contact | Gender | While FHIR defines patient​.gender as a code set, its Salesforce implementation is a picklist​. |
| birthDate | Contact | Birthdate | |
| deceasedDateTime | Contact | DeceasedDate | While FHIR defines patient​.deceased as either a boolean or a date, Salesforce supports only a date​. |
| maritalStatus | Contact | maritalStatus | While FHIR defines patient​.marital​Status as a code set bundle, its Salesforce implementation is a picklist​. |
| multipleBirthInteger | Contact | SequenceInMultipleBirth | While FHIR defines patient​.multiple​Birth as either a boolean or an integer, Salesforce supports only an integer​. |
| telecom.system | ContactPointEmail | If the object is of type ContactPointEmail then this field is set to 'email'. | |
| telecom.value | ContactPointEmail | EmailAddress | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. |
| telecom.use | ContactPointEmail | UsageType | |
| telecom.rank | ContactPointEmail | PreferenceRank | |
| telecom.period.start | ContactPointEmail | ActiveFromDate | |
| telecom.period.end | ContactPointEmail | ActiveToDate | |
| telecom.system | ContactPointPhone | If the object is of type ContactPointPhone then this field is set to 'phone'. | |
| telecom.value | ContactPointPhone | TelephoneNumber | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. |
| telecom.use | ContactPointPhone | UsageType | |
| telecom.rank | ContactPointPhone | PreferenceRank | |
| telecom.period.start | ContactPointPhone | ActiveFromDate | |
| telecom.period.end | ContactPointPhone | ActiveToDate | |
| identifier.value | Identifier | IdValue | The identifier information for a patient is represented as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field​. |
| identifier.assigner | Identifier | IssuingAuthorityId | |
| identifier.type.coding.code | Identifier | IdTypeId | |
| address.use | ContactPointAddress | UsageType | The address information for a patient is represented as Contact​Point​Address records that reference the patient record using their Contact​Point​Address​.ParentId field​. |
| address.line | ContactPointAddress | Street | |
| address.city | ContactPointAddress | City | |
| address.state | ContactPointAddress | State | |
| address.postalCode | ContactPointAddress | PostalCode | |
| address.country | ContactPointAddress | Country | |
| address.type | ContactPointAddress | AddressType | |
| contact.name.family | PersonName | LastName | The name information for a contact is represented as Person​Name records that reference the contact record of the contact’s person account using their Person​Name​.Parent​RecordId field​. While FHIR defines patient​.contact​.name as a zero-to-one resource, the Salesforce implementation can support zero-to-many references​. |
| contact.name.given | PersonName | FirstName | |
| contact.name.suffix | PersonName | Suffix | |
| contact.name.prefix | PersonName | Prefix | |
| contact.name.use | PersonName | NameUsageType | |
| contact.gender | Contact | Gender | While FHIR defines patient​.contact​.gender as a code set, its Salesforce implementation is a picklist​. |
| contact.relationship.coding.code | HealthCloudGA__ ContactContactRelation__c | HealthCloudGA__ Role__c | While FHIR defines patient​.contact​.relationship as a code set bundle, its Salesforce implementation is a reference to ReicprocalRole__c​. |
| contact.telecom.system | ContactPointEmail | If the object is of type ContactPointEmail then this field is set to 'email'. | |
| contact.telecom.value | ContactPointEmail | EmailAddress | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. |
| contact.telecom.use | ContactPointEmail | UsageType | |
| contact.telecom.rank | ContactPointEmail | PreferenceRank | |
| contact.telecom.period.start | ContactPointEmail | ActiveFromDate | |
| contact.telecom.period.end | ContactPointEmail | ActiveToDate | |
| contact.telecom.system | ContactPointPhone | If the object is of type ContactPointPhone then this field is set to 'phone'. | |
| contact.telecom.value | ContactPointPhone | TelephoneNumber | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. |
| contact.telecom.use | ContactPointPhone | UsageType | |
| contact.telecom.rank | ContactPointPhone | PreferenceRank | |
| contact.telecom.period.start | ContactPointPhone | ActiveFromDate | |
| contact.telecom.period.end | ContactPointPhone | ActiveToDate | |
| contact.address.use | ContactPointAddress | UsageType | The address information for a contact is represented as Contact​Point​Address records that reference the contact’s person account record using their Contact​Point​Address​.ParentId field​. While FHIR defines patient​.contact​.address as a zero-to-one resource, the Salesforce implementation can support zero-to-many references​. |
| contact.address.line | ContactPointAddress | Street | |
| contact.address.city | ContactPointAddress | City | |
| contact.address.state | ContactPointAddress | State | |
| contact.address.postalCode | ContactPointAddress | PostalCode | |
| contact.address.country | ContactPointAddress | Country | |
| contact.address.type | ContactPointAddress | AddressType | |
| communication.language. coding.display | PersonLanguage | Language | The language information for a patient is represented as Person​Language records that reference the patient record using their Person​Language​.IndividualId field​. While FHIR defines patient​.communication​.language as a code set bundle, its Salesforce implementation is a picklist​. |
| communication.preferred | PersonLanguage | Rank | While FHIR defines patient​.communication​.preferred as a boolean, its Salesforce implementation is an integer field that ranks the degree of preference​. |
| us-core-race.extension:ombCategory..system | Contact | Race_Ext_OmbCategory_ ValueCoding_Sys1__c | |
| us-core-race.extension:ombCategory..code | Contact | Race_Ext_OmbCategory_ ValueCoding_Code1__c | |
| us-core-race.extension:ombCategory..display | Contact | Race_Ext_OmbCategory_ ValueCoding_DP1__c | |
| us-core-race.extension:ombCategory..system | Contact | Race_Ext_OmbCategory_ ValueCoding_Sys2__c | |
| us-core-race.extension:ombCategory..code | Contact | Race_Ext_OmbCategory_ ValueCoding_Code2__c | |
| us-core-race.extension:ombCategory..display | Contact | Race_Ext_OmbCategory_ ValueCoding_DP2__c | |
| us-core-race.extension:ombCategory..system | Contact | Race_Ext_OmbCategory_ ValueCoding_Sys3__c | |
| us-core-race.extension:ombCategory..code | Contact | Race_Ext_OmbCategory_ ValueCoding_Code3__c | |
| us-core-race.extension:ombCategory..display | Contact | Race_Ext_OmbCategory_ ValueCoding_DP3__c | |
| us-core-race.extension:detailed..system | Contact | Race_Ext_Detailed_ ValueCoding_Sys1__c | |
| us-core-race.extension:detailed..code | Contact | Race_Ext_Detailed_ ValueCoding_Code1__c | |
| us-core-race.extension:detailed..display | Contact | Race_Ext_Detailed_ ValueCoding_DP1__c | |
| us-core-race.extension:detailed..system | Contact | Race_Ext_Detailed_ ValueCoding_Sys2__c | |
| us-core-race.extension:detailed..code | Contact | Race_Ext_Detailed_ ValueCoding_Code2__c | |
| us-core-race.extension:detailed..display | Contact | Race_Ext_Detailed_ ValueCoding_DP2__c | |
| us-core-race.extension:text..valueString | Contact | Race_Ext_ValueString__c | |
| us-core-ethnicity.extension:ombCategory..system | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_Sys1__c | |
| us-core-ethnicity.extension:ombCategory..code | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_Code1__c | |
| us-core-ethnicity.extension:ombCategory..display | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_DP1__c | |
| us-core-ethnicity.extension:ombCategory..system | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_Sys2__c | |
| us-core-ethnicity.extension:ombCategory..code | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_Code2__c | |
| us-core-ethnicity.extension:ombCategory..display | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_DP2__c | |
| us-core-ethnicity.extension:ombCategory..system | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_Sys3__c | |
| us-core-ethnicity.extension:ombCategory..code | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_Code3__c | |
| us-core-ethnicity.extension:ombCategory..display | Contact | Ethnic_Ext_OmbCategory_ ValueCoding_DP3__c | |
| us-core-ethnicity.extension:detailed..system | Contact | Ethnic_Ext_Detailed_ ValueCoding_Sys1__c | |
| us-core-ethnicity.extension:detailed..code | Contact | Ethnic_Ext_Detailed_ ValueCoding_Code1__c | |
| us-core-ethnicity.extension:detailed..display | Contact | Ethnic_Ext_Detailed_ ValueCoding_DP1__c | |
| us-core-ethnicity.extension:detailed..system | Contact | Ethnic_Ext_Detailed_ ValueCoding_Sys2__c | |
| us-core-ethnicity.extension:detailed..code | Contact | Ethnic_Ext_Detailed_ ValueCoding_Code2__c | |
| us-core-ethnicity.extension:detailed..display | Contact | Ethnic_Ext_Detailed_ ValueCoding_DP2__c | |
| us-core-ethnicity.extension:text..valueString | Contact | Ethnic_Ext_ValueString__c | |
| us-core-birthsex.url | Contact | Birthsex_Ext_URL__c | |
| us-core-birthsex.valueCode | Contact | Birthsex_Ext_ValueCode__c | |
| contact | HealthCloudGA__ ContactContact Relation__c | HealthCloudGA__ RelatedContact__c | Contacts are connected to patients using the Contact​Contact​Relation__c junction object​. The Contact​​Contact​​Relation__c​​.Contact__c field references the contact record of the patient’s person account, and the Contact​​Contact​​Relation__c​​.Related​Contact__c field references the contact record of the contact’s person account​. |
| contact.relationship | HealthCloudGA__ ContactContact Relation__c | HealthCloudGA__ Role__c | While FHIR defines patient​.contact​.relationship as a code set bundle, its Salesforce implementation is a reference to ReicprocalRole__c​. |
Practitioner Resource
| FHIR Field Name | Salesforce Object Name | Salesforce Field Name | Notes |
|---|---|---|---|
| active | Account​ | IsActive | |
| name.family | Person Name | LastName | The name information for a patient is represented as Person​Name records that reference the patient record using their Person​Name​.PractitionerRecordId field​. |
| name.given | Person Name | FirstName | |
| name.prefix | Person Name | Prefix | |
| name.suffix | Person Name | Suffix | |
| name.family | Person Name | LastName | |
| gender | Contact​ | Gender | |
| birthDate | Contact​ | Birthdate | While FHIR defines Practitioner​.gender as a code set, its Salesforce implementation is a picklist​. |
| deceasedDateTime | Contact​ | DeceasedDate | While FHIR defines patient​.deceased as either a boolean or a date, Salesforce supports only a date​. |
| maritalStatus | Contact​ | maritalStatus | While FHIR defines patient​.marital​Status as a code set bundle, its Salesforce implementation is a picklist​. |
| multipleBirthInteger | Contact​ | SequenceInMultipleBirth | While FHIR defines patient​.multiple​Birth as either a boolean or an integer, Salesforce supports only an integer​. |
| identifier.value | Identifier | IdValue | The identifier information for a patient is represented as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field​. |
| identifier.assigner | Identifier | IssuingAuthorityId | |
| identifier.type.coding.code | Identifier | IdTypeId | |
| telecom.system | ContactPointEmail | If the object is of type ContactPointEmail then this field is set to 'email'. | |
| telecom.value | ContactPointEmail | EmailAddress | The telecom information for a patient is represented as Contact​Point​Email records that reference the patient record using their Contact​Point​Email.ParentId field​. |
| telecom.use | ContactPointEmail | UsageType | |
| telecom.rank | ContactPointEmail | PreferenceRank | |
| telecom.period.start | ContactPointEmail | ActiveFromDate | |
| telecom.period.end | ContactPointEmail | ActiveToDate | |
| telecom.system | ContactPointPhone | If the object is of type ContactPointPhone then this field is set to 'phone'. | |
| telecom.value | ContactPointPhone | TelephoneNumber | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. |
| telecom.use | ContactPointPhone | UsageType | |
| telecom.rank | ContactPointPhone | PreferenceRank | |
| telecom.period.start | ContactPointPhone | ActiveFromDate | |
| telecom.period.end | ContactPointPhone | ActiveToDate | |
| address.use | ContactPointAddresses | UsageType | The address information for a patient is represented as Contact​Point​Address records that reference the patient record using their Contact​Point​Address​.ParentId field​. |
| address.text | ContactPointAddresses | Name | |
| address.line | ContactPointAddresses | Street | |
| address.city | ContactPointAddresses | City | |
| address.state | ContactPointAddresses | State | |
| address.postalCode | ContactPointAddresses | PostalCode | |
| address.country | ContactPointAddresses | Country | |
| communication.coding.display | PersonLanguage | Language | The language information for a patient is represented as Person​Language records that reference the patient record using their Person​Language​.IndividualId field​. While FHIR defines practitioner​.communication​ as a code set bundle, its Salesforce implementation is a picklist​. |
PractitionerRole Resource
| FHIR Field Name | Salesforce Object Name | Salesforce Field Name | Notes |
|---|---|---|---|
| active | HealthcarePractitionerFacility | IsActive | |
| period.start | Healthcare​Practitioner​Facility​ | EffectiveFrom | |
| period.end | Healthcare​Practitioner​Facility​ | EffectiveTo | |
| practitioner.reference | Healthcare​Practitioner​Facility​ | PractitionerId | This fields references the contact record of the practitioner’s person account. |
| practitioner.display | Healthcare​Practitioner​Facility​ | Name | |
| location.reference | Healthcare​Practitioner​Facility​ | AccountId | While FHIR defines practitioner​Role​.location as a direct reference to Healthcare​Facility, the Salesforce implementation references it indirectly. This is done by referencing the local business account of the required facility using the ​Healthcare​Practitioner​Facility​.AccountId field. The Salesforce implementation supports only one practitioner​Role​.location reference for each practitioner role. |
| location.display | Healthcare​Practitioner​Facility​ | Name | |
| Identifier.use | Identifier | IdUsageType | The identifier information for a practitioner​Role is represented as Identifier records that reference the Healthcare​Practitioner​Facility record using their Identifier​.Parent​RecordId field​. |
| Identifier.system | Identifier | SourceSystem | |
| Identifier.value | Identifier | IdValue | |
| code.coding.code | CareProvider​Facility​Specialty | SpecialtyRole | While FHIR defines practitioner​Role​.code as a code set bundle, its Salesforce implementation is a picklist​. Zero-to-many values can be associated by creating multiple CareProvider​Facility​Specialty​ records that reference a Healthcare​Practitioner​Facility​record. However, a single CareProvider​Facility​Specialty​ record can have only one combination of role and specialty. |
| code.coding.display | CareProvider​Facility​Specialty | Name | |
| specialty.coding.code | CareProvider​Facility​Specialty | Specialty​Id | While FHIR defines practitioner​Role​.code as a code set bundle, its Salesforce implementation is a CareSpecialty reference​. Zero-to-many values can be associated by creating multiple CareProvider​Facility​Specialty​ records that reference a Healthcare​Practitioner​Facility​record. However, a single CareProvider​Facility​Specialty​ record can have only one combination of role and specialty. |
| specialty.coding.code | CareProvider​Facility​Specialty | Name |
Encounter Resource
| FHIR Field Name | Salesforce Object Name | Salesforce Field Name | Notes |
|---|---|---|---|
| status | ClinicalEncounter | Status | |
| class.code | ClinicalEncounter | Category | |
| type | ClinicalEncounter | TypeId | While F​HI​R defines encounter​.type as a zero-to-many resource, the Salesforce implementation is zero-to-one​. Every type.coding is stored in CodeSet object and its reference list in CodeSetBundle object. CodeSetBundle object reference is stored in TypeId field. |
| priority | ClinicalEncounter | PriorityId | priority.coding details are stored in CodeSet object and its reference list in CodeSetBundle object. CodeSetBundle object reference is stored in PriorityId field. |
| subject | ClinicalEncounter | PatientId | |
| period.start | ClinicalEncounter | StartDate | |
| period.end | ClinicalEncounter | EndDate | |
| hospitalization.preAdmission Identifier.use | Clinical Encounter Identifier | IdUsage​Type | |
| hospitalization.preAdmission Identifier.value | Clinical Encounter Identifier | IDValue | |
| hospitalization.preAdmission Identifier.system | Clinical Encounter Identifier | SourceSystem | |
| hospitalization.preAdmissionIdentifier | ClinicalEncounter | PreAdmissionIdentifierId | Store hospitalization.preAdmissionIdentifier details into ClinicalEncounterIdentifier object and have a reference of it in PreAdmissionIdentifierId field. |
| hospitalization.origin | ClinicalEncounter | PreviousFacilityId | |
| hospitalization.admitSource. coding.code | ClinicalEncounter | AdmissionSource | |
| hospitalization.reAdmission | ClinicalEncounter | ReadmissionCodeId | Every hospitalization.reAdmission.coding is stored in CodeSet object and its reference list in CodeSetBundle object. CodeSetBundle object reference is stored in ReadmissionCodeId field. |
| hospitalization.dietPreference. coding.code | ClinicalEncounter | DietPreference | |
| hospitalization.specialCourtesy. coding.code | ClinicalEncounter | SpecialCourtesy | |
| hospitalization.discharge Disposition | ClinicalEncounter | DischargeDispositionId | Every hospitalization.dischargeDisposition.coding is stored in CodeSet object and its reference list in CodeSetBundle object. CodeSetBundle object reference is stored in DischargeDispositionId field. |
| serviceProvider | ClinicalEncounter | FacilityId | |
| Identifier.use | ClinicalEncounterIdentifier | IdUsageType | The identifier information for an encounter is represented as ​​Clinical​Encounter​Identifier records that reference the encounter record using their ​​Clinical​Encounter​Identifier​.​Parent​RecordId field​. |
| Identifier.system | ClinicalEncounterIdentifier | SourceSystem | |
| Identifier.value | ClinicalEncounterIdentifier | IdValue | |
| participant | ClinicalEncounterProvider | N/A | The participant information for an encounter is represented as ​​Clinical​Encounter​​Provider records that reference the encounter record using their ​​Clinical​Encounter​​Provider​.​​Clinical​Encounter​Id field​. |
| participant.type | ClinicalEncounterProvider | Practitioner​TypeId | While F​HI​R defines encounter​.participant​.type as a zero-to-many resource, the Salesforce implementation is zero-to-one​. Every type.coding is stored in CodeSet object and list of it in CodeSetBundle object. |
| participant.individual | ClinicalEncounterProvider | PractitionerId | |
| reasonCode | ClinicalEncounterReason | ReasonCodeId | The reason for an encounter is represented as ​​Clinical​Encounter​​Reason records that reference the encounter record using their ​​Clinical​Encounter​​Reason​.​​Clinical​Encounter​Id field​. Every reasoncode.coding is stored in CodeSet object and list of it in CodeSetBundle object. |
Location Resource
| FHIR Field Name | Salesforce Object | Salesforce Field Name | Notes |
|---|---|---|---|
| name | Location | Name | |
| status | Account | IsActive | While FHIR defines location​.status as a code, the salesforce implementation is a boolean field in the referenced account record​. |
| description | Location | Description | |
| position.longitude | Location | Longitude | The location​.position FHIR resource is mapped to the Location​.Location salesforce field​. This location (Salesforce object) record is referenced by the healthcare facility record using its Healthcare​Facility​.LocationId lookup field​. position​.altitude is not supported in Location​.Location​. |
| position.latitude | Location | Latitude | |
| availabilityExceptions | HealthcareFacility | AvailabilityExceptions | |
| partOf | HealthcareFacility | ParentHealthcareFacilityId | |
| type.coding.code | CodeSet | Code | While FHIR defines location​.type as a zero-to-many resource, Salesforce implements Healthcare​Facility​.​Facility​TypeId as a zero-to-one field​. |
| type.coding.display | CodeSet | CodeDescription | While FHIR defines location​.physical​Type as a code set bundle, Salesforce implements Healthcare​Facility​.Location​Type as a picklist​. |
| type.coding.system | CodeSet | SourceSystem | |
| physicalType.coding.display | HealthcareFacility | LocationType | |
| identifier.value | Identifier | IdValue | The identifier information for a practitioner​Role is represented as Identifier records that reference the Healthcare​Practitioner​Facility record using their Identifier​.Parent​RecordId field​. |
| identifier.type.coding.code | Identifier | IdTypeId | |
| identifier.assigner | Identifier | IssuingAuthorityId | |
| telecom.system | ContactPointEmail | If the object is of type ContactPointEmail then this field is set to 'email'. | |
| telecom.value | ContactPointEmail | EmailAddress | The telecom information of the facility is stored as Contact​Point​Phone records that reference the account referenced by the facility record​. |
| telecom.use | ContactPointEmail | UsageType | |
| telecom.rank | ContactPointEmail | PreferenceRank | |
| telecom.period.start | ContactPointEmail | ActiveFromDate | |
| telecom.period.end | ContactPointEmail | ActiveToDate | |
| telecom.system | ContactPointPhone | If the object is of type ContactPointPhone then this field is set to 'phone'. | |
| telecom.value | ContactPointPhone | TelephoneNumber | The telecom information of the facility is stored as Contact​Point​Phone records that reference the account referenced by the facility record​. |
| telecom.use | ContactPointPhone | UsageType | |
| telecom.rank | ContactPointPhone | PreferenceRank | |
| telecom.period.start | ContactPointPhone | ActiveFromDate | |
| telecom.period.end | ContactPointPhone | ActiveToDate | |
| address.use | ContactPointAddress | UsageType | The address information of the facility is stored as Contact​Point​Address records that reference the account referenced by the facility record​. |
| address.line | ContactPointAddress | Street | |
| address.city | ContactPointAddress | City | |
| address.state | ContactPointAddress | State | |
| address.postalCode | ContactPointAddress | PostalCode | |
| address.country | ContactPointAddress | Country | |
| address.type | ContactPointAddress | AddressType | |
| managingOrganization | HealthCloudGA__ RelatedFromAccounts__r | HealthCloudGA__ RelatedAccount__c | The junction object that connects the facility account with the parent organization’s business account​. |
Organization Resource
| FHIR Field Name | Salesforce Object Name | Salesforce Field Name | Notes |
|---|---|---|---|
| Identifier.use | Identifier | IdUsageType | The identifier information for an organization is represented as Identifier records that reference the organization record using their Identifier​.Parent​RecordId field​. |
| Identifier.system | Identifier | SourceSystem | |
| Identifier.value | Identifier | IdValue | |
| active | Account | IsActive | |
| type.coding.code | Account | Type | While FHIR defines account​.type as a zero-to-many code set bundle reference, its Salesforce implementation is a zero-to-one picklist​. |
| name | Account | Name | |
| telecom.system | ContactPointEmail | The telecom information for an organization is represented as ContactPointEmail records that reference the organization record using their ContactPointEmail​.ParentId field​. | |
| telecom.value | ContactPointEmail | EmailAddress | |
| telecom.use | ContactPointEmail | UsageType | |
| telecom.rank | ContactPointEmail | PreferenceRank | |
| telecom.period.start | ContactPointEmail | ActiveFromDate | |
| telecom.period.end | ContactPointEmail | ActiveToDate | |
| telecom.system | ContactPointPhone | The telecom information for an organization is represented as Contact​Point​Phone records that reference the organization record using their Contact​Point​Phone​.ParentId field​. | |
| telecom.value | ContactPointPhone | TelephoneNumber | |
| telecom.use | ContactPointPhone | UsageType | |
| telecom.rank | ContactPointPhone | PreferenceRank | |
| telecom.period.start | ContactPointPhone | ActiveFromDate | |
| telecom.period.end | ContactPointPhone | ActiveToDate | |
| address.use | ContactPointAddress | UsageType | The address information for an organization is represented as Contact​Point​Address records that reference the organization record using their Contact​Point​Address​.ParentId field​. |
| address.line | ContactPointAddress | Street | |
| address.city | ContactPointAddress | City | |
| address.state | ContactPointAddress | State | |
| address.postalCode | ContactPointAddress | PostalCode | |
| address.country | ContactPointAddress | Country | |
| address.type | ContactPointAddress | AddressType | |
| contact.name.family | PersonName | LastName | The name information for a contact is represented as Person​Name records that reference the contact’s person account using their Person​Name​.Parent​RecordId field​. |
| contact.name.given | PersonName | FirstName | |
| contact.name.suffix | PersonName | Suffix | |
| contact.name.prefix | PersonName | Prefix | |
| contact.name.use | PersonName | NameUsageType | |
| contact.telecom.system | ContactPointEmail | The telecom information for a contact is represented as Contact​Point​Email records that reference the contact’s person account record using their Contact​Point​Email​.ParentId field​. | |
| contact.telecom.value | ContactPointEmail | EmailAddress | |
| contact.telecom.use | ContactPointEmail | UsageType | |
| contact.telecom.rank | ContactPointEmail | PreferenceRank | |
| contact.telecom.period.start | ContactPointEmail | ActiveFromDate | |
| contact.telecom.period.end | ContactPointEmail | ActiveToDate | |
| contact.telecom.system | ContactPointPhone | The telecom information for a contact is represented as Contact​Point​Phone records that reference the contact’s person account record using their Contact​Point​Phone​.ParentId field​. | |
| contact.telecom.value | ContactPointPhone | TelephoneNumber | |
| contact.telecom.use | ContactPointPhone | UsageType | |
| contact.telecom.rank | ContactPointPhone | PreferenceRank | |
| contact.telecom.period.start | ContactPointPhone | ActiveFromDate | |
| contact.telecom.period.end | ContactPointPhone | ActiveToDate | |
| contact.address.use | ContactPointAddress | UsageType | The address information for a contact is represented as Contact​Point​Address records that reference the contact’s person account record using their Contact​Point​Address​.ParentId field​. |
| contact.address.line | ContactPointAddress | Street | |
| contact.address.city | ContactPointAddress | City | |
| contact.address.state | ContactPointAddress | State | |
| contact.address.postalCode | ContactPointAddress | PostalCode | |
| contact.address.country | ContactPointAddress | Country | |
| contact.address.type | ContactPointAddress | AddressType | |
| contact | Account​Contact​Relation | ContactId | Contacts are connected to organizations using the Account​Contact​Relation junction object​. The Account​Contact​Relation​.AccountId field references the organization’s account record, and the Account​Contact​Relation​.ContactId field references the contact record of the contact’s person account​. |
| contact.purpose | Account​Contact​Relation | Roles | While FHIR defines organization​.contact​.purpose as a code set bundle, its Salesforce implementation is a picklist​. |
RelatedPerson Resource
| FHIR Field Name | Salesforce Object Name | Salesforce Field Name | Notes |
|---|---|---|---|
| active | Account​ | IsActive | |
| Identifier.use | Identifier | IdUsageType | The identifier information for a related person is represented as Identifier records that reference the related person’s person account using their Identifier​.Parent​RecordId field |
| Identifier.system | Identifier | SourceSystem | |
| Identifier.value | Identifier | IdValue | |
| name.family | Person Name | LastName | The name information for a patient is represented as Person​Name records that reference the patient record using their Person​Name​.PractitionerRecordId field​. |
| name.given | Person Name | FirstName | |
| name.prefix | Person Name | Prefix | |
| name.suffix | Person Name | Suffix | |
| gender | Contact​ | Gender | While FHIR defines RelatedPerson​.gender as a code set, its Salesforce implementation is a picklist​. |
| birthDate | Contact​ | Birthdate | While FHIR defines RelatedPerson​.deceased as either a boolean or a date, Salesforce supports only a date​. |
| deceasedDateTime | Contact​ | DeceasedDate | While FHIR defines RelatedPerson​.marital​Status as a code set bundle, its Salesforce implementation is a picklist​. |
| maritalStatus | Contact​ | maritalStatus | While FHIR defines RelatedPerson​.multiple​Birth as either a boolean or an integer, Salesforce supports only an integer​. |
| multipleBirthInteger | Contact​ | SequenceInMultipleBirth | |
| telecom.system | ContactPointEmail | If the object is of type ContactPointEmail then this field is set to 'email'. | |
| telecom.value | ContactPointEmail | EmailAddress | The telecom information for a patient is represented as Contact​Point​Email records that reference the patient record using their Contact​Point​Email.ParentId field​. |
| telecom.use | ContactPointEmail | UsageType | |
| telecom.rank | ContactPointEmail | PreferenceRank | |
| telecom.period.start | ContactPointEmail | ActiveFromDate | |
| telecom.period.end | ContactPointEmail | ActiveToDate | |
| telecom.system | ContactPointPhone | If the object is of type ContactPointPhone then this field is set to 'phone'. | |
| telecom.value | ContactPointPhone | TelephoneNumber | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. |
| telecom.use | ContactPointPhone | UsageType | |
| telecom.rank | ContactPointPhone | PreferenceRank | |
| telecom.period.start | ContactPointPhone | ActiveFromDate | |
| telecom.period.end | ContactPointPhone | ActiveToDate | |
| address.use | ContactPointAddresses | UsageType | The address information for a related person is represented as Contact​Point​Address records that reference the related person’s person account using their Contact​Point​Address​.ParentId field​. |
| address.text | ContactPointAddresses | Name | |
| address.line | ContactPointAddresses | Street | |
| address.city | ContactPointAddresses | City | |
| address.state | ContactPointAddresses | State | |
| address.postalCode | ContactPointAddresses | PostalCode | |
| address.country | ContactPointAddresses | Country | |
| communication.language. coding.display | Person​Language​ | ​Language | The language information for a patient is represented as Person​Language records that reference the patient record using their Person​Language​.IndividualId field​. While FHIR defines relatedperson.communication​.language as a code set bundle, its Salesforce implementation is a picklist​. |
| communication.preferred | Person​Language​ | Rank | While FHIR defines relatedperson.communication​.preferred as a boolean, its Salesforce implementation is an integer field that ranks the degree of preference​. |
| patient | HealthCloudGA__ Contact​Contact​Relation__c​ | HealthCloudGA__ Contact__c | |
| relationship | HealthCloudGA__ Contact​​Contact​​Relation__c​​ | HealthCloudGA__ Role__c | While FHIR defines relatedPerson​.relationship as a code set bundle, its Salesforce implementation is a reference to ReicprocalRole__c​. |
| period.start | HealthCloudGA__ Contact​​Contact​​Relation__c | HealthCloudGA__ StartDate__c | |
| period.end | HealthCloudGA__ Contact​​Contact​​Relation__c | HealthCloudGA__ EndDate__c |